<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace Heap APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.9.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__heap__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trace Heap APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac175bec46c970c1bdf93af8f11661202"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#gac175bec46c970c1bdf93af8f11661202">xTraceHeapGetCurrent</a>(xHeapHandle,  puxCurrent)&#160;&#160;&#160;xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, puxCurrent)</td></tr>
<tr class="memdesc:gac175bec46c970c1bdf93af8f11661202"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace heap current allocation size.  <br /></td></tr>
<tr class="separator:gac175bec46c970c1bdf93af8f11661202"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39fe6a7b64b427a7a0752e03d341efa0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#ga39fe6a7b64b427a7a0752e03d341efa0">xTraceHeapSetCurrent</a>(xHeapHandle,  uxCurrent)&#160;&#160;&#160;xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent)</td></tr>
<tr class="memdesc:ga39fe6a7b64b427a7a0752e03d341efa0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace heap current allocation size.  <br /></td></tr>
<tr class="separator:ga39fe6a7b64b427a7a0752e03d341efa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad91b812503db77649fb0b7dbbc6f1b06"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#gad91b812503db77649fb0b7dbbc6f1b06">xTraceHeapGetHighWaterMark</a>(xHeapHandle,  puxHighWaterMark)&#160;&#160;&#160;xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, puxHighWaterMark)</td></tr>
<tr class="memdesc:gad91b812503db77649fb0b7dbbc6f1b06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace heap high water mark.  <br /></td></tr>
<tr class="separator:gad91b812503db77649fb0b7dbbc6f1b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaefff3aef00cf79ad8bde043924b65ac6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#gaefff3aef00cf79ad8bde043924b65ac6">xTraceHeapSetHighWaterMark</a>(xHeapHandle,  uxHighWaterMark)&#160;&#160;&#160;xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, uxHighWaterMark)</td></tr>
<tr class="memdesc:gaefff3aef00cf79ad8bde043924b65ac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace heap high water mark.  <br /></td></tr>
<tr class="separator:gaefff3aef00cf79ad8bde043924b65ac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5821b71f3db97441937f34fbc517dcf8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#ga5821b71f3db97441937f34fbc517dcf8">xTraceHeapGetMax</a>(xHeapHandle,  puxMax)&#160;&#160;&#160;xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, puxMax)</td></tr>
<tr class="memdesc:ga5821b71f3db97441937f34fbc517dcf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace heap max size.  <br /></td></tr>
<tr class="separator:ga5821b71f3db97441937f34fbc517dcf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba96f25b94668735c822ed60a92b1fe4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#gaba96f25b94668735c822ed60a92b1fe4">xTraceHeapSetMax</a>(xHeapHandle,  uxMax)&#160;&#160;&#160;xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, uxMax)</td></tr>
<tr class="memdesc:gaba96f25b94668735c822ed60a92b1fe4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace heap max size.  <br /></td></tr>
<tr class="separator:gaba96f25b94668735c822ed60a92b1fe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5f6be05d2acc8cea5e50950da0b66e28"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#ga5f6be05d2acc8cea5e50950da0b66e28">xTraceHeapCreate</a> (const char *szName, TraceUnsignedBaseType_t uxCurrent, TraceUnsignedBaseType_t uxHighWaterMark, TraceUnsignedBaseType_t uxMax, TraceHeapHandle_t *pxHeapHandle)</td></tr>
<tr class="memdesc:ga5f6be05d2acc8cea5e50950da0b66e28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates trace heap.  <br /></td></tr>
<tr class="separator:ga5f6be05d2acc8cea5e50950da0b66e28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga796394ad6125b93f2364423c507d29f6"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#ga796394ad6125b93f2364423c507d29f6">xTraceHeapAlloc</a> (TraceHeapHandle_t xHeapHandle, void *pvAddress, TraceUnsignedBaseType_t uxSize)</td></tr>
<tr class="memdesc:ga796394ad6125b93f2364423c507d29f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals trace heap alloc.  <br /></td></tr>
<tr class="separator:ga796394ad6125b93f2364423c507d29f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac340975066a0b80870d0dba4e9aebb60"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__heap__apis.html#gac340975066a0b80870d0dba4e9aebb60">xTraceHeapFree</a> (TraceHeapHandle_t xHeapHandle, void *pvAddress, TraceUnsignedBaseType_t uxSize)</td></tr>
<tr class="memdesc:gac340975066a0b80870d0dba4e9aebb60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals trace heap free.  <br /></td></tr>
<tr class="separator:gac340975066a0b80870d0dba4e9aebb60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gac175bec46c970c1bdf93af8f11661202" name="gac175bec46c970c1bdf93af8f11661202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac175bec46c970c1bdf93af8f11661202">&#9670;&#160;</a></span>xTraceHeapGetCurrent</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceHeapGetCurrent</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xHeapHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">puxCurrent&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, puxCurrent)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace heap current allocation size. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">puxCurrent</td><td>Current.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gad91b812503db77649fb0b7dbbc6f1b06" name="gad91b812503db77649fb0b7dbbc6f1b06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad91b812503db77649fb0b7dbbc6f1b06">&#9670;&#160;</a></span>xTraceHeapGetHighWaterMark</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceHeapGetHighWaterMark</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xHeapHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">puxHighWaterMark&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, puxHighWaterMark)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace heap high water mark. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">puxHighWaterMark</td><td>High water mark.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga5821b71f3db97441937f34fbc517dcf8" name="ga5821b71f3db97441937f34fbc517dcf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5821b71f3db97441937f34fbc517dcf8">&#9670;&#160;</a></span>xTraceHeapGetMax</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceHeapGetMax</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xHeapHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">puxMax&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, puxMax)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets trace heap max size. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">puxMax</td><td>Max.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga39fe6a7b64b427a7a0752e03d341efa0" name="ga39fe6a7b64b427a7a0752e03d341efa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga39fe6a7b64b427a7a0752e03d341efa0">&#9670;&#160;</a></span>xTraceHeapSetCurrent</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceHeapSetCurrent</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xHeapHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxCurrent&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace heap current allocation size. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxCurrent</td><td>Current.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaefff3aef00cf79ad8bde043924b65ac6" name="gaefff3aef00cf79ad8bde043924b65ac6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaefff3aef00cf79ad8bde043924b65ac6">&#9670;&#160;</a></span>xTraceHeapSetHighWaterMark</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceHeapSetHighWaterMark</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xHeapHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxHighWaterMark&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, uxHighWaterMark)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace heap high water mark. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxHighWaterMark</td><td>High water mark.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaba96f25b94668735c822ed60a92b1fe4" name="gaba96f25b94668735c822ed60a92b1fe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaba96f25b94668735c822ed60a92b1fe4">&#9670;&#160;</a></span>xTraceHeapSetMax</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceHeapSetMax</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xHeapHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxMax&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, uxMax)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace heap max size. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxMax</td><td>Max heap size.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga796394ad6125b93f2364423c507d29f6" name="ga796394ad6125b93f2364423c507d29f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga796394ad6125b93f2364423c507d29f6">&#9670;&#160;</a></span>xTraceHeapAlloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceHeapAlloc </td>
          <td>(</td>
          <td class="paramtype">TraceHeapHandle_t&#160;</td>
          <td class="paramname"><em>xHeapHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Signals trace heap alloc. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvAddress</td><td>Address. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxSize</td><td>Size.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga5f6be05d2acc8cea5e50950da0b66e28" name="ga5f6be05d2acc8cea5e50950da0b66e28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5f6be05d2acc8cea5e50950da0b66e28">&#9670;&#160;</a></span>xTraceHeapCreate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceHeapCreate </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxCurrent</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxHighWaterMark</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxMax</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceHeapHandle_t *&#160;</td>
          <td class="paramname"><em>pxHeapHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates trace heap. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxCurrent</td><td>Current level. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxHighWaterMark</td><td>High water mark </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxMax</td><td>Maximum level. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxHeapHandle</td><td>Pointer to uninitialized trace heap handle. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>traceResult </dd></dl>

</div>
</div>
<a id="gac340975066a0b80870d0dba4e9aebb60" name="gac340975066a0b80870d0dba4e9aebb60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac340975066a0b80870d0dba4e9aebb60">&#9670;&#160;</a></span>xTraceHeapFree()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceHeapFree </td>
          <td>(</td>
          <td class="paramtype">TraceHeapHandle_t&#160;</td>
          <td class="paramname"><em>xHeapHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Signals trace heap free. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xHeapHandle</td><td>Trace heap handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvAddress</td><td>Address. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxSize</td><td>Size.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
